Class: modelit.ui.CheckBox

Extends: modelit.ui.Jacontrol & modelit.ui.AbstractJacontrol & matlab.mixin.SetGet & handle & matlab.mixin.Heterogeneous

DESCRIPTION:

An item with a text string or an image, or both, that can be selected or deselected Checkboxes are intended for providing the user with a number of independent choices. Checkboxes trigger a callback when selected and indicate their state on the display. To activate a checkbox, click the mouse button on the object.

Properties

BackgroundColor RGB triple, default value is system dependent
 The background color of the checkbox.
BusyAction cancel | {queue}
 Callback queuing.
 Determines how MATLAB handles the execution of interrupting callbacks.
 A running callback is the currently executing callback. The interrupting callback is the callback that tries to interrupt the running callback.
 The BusyAction property of the interrupting callback determines how MATLAB handles its execution. When the BusyAction property is set to:
  'queue' ? Puts the interrupting callback in a queue to be processed after the running callback finishes execution.
  'cancel' ? Discards the interrupting callback as MATLAB finishes execution.
 For information about how the Interruptible property of the callback controls whether other callbacks can interrupt the running callback, see the Interruptible property description.
Callback Function handle, default value: []
 Specifies the function that should be executed when the user selects or deselects the checkbox.
Children The component's children.
Clipping clipping
 Clipping mode.
 This property has no direct effect on the objects
 Use this property if you want to implement your own custom
CMenu Handle, default value: []
 The handle of the context menu associated with the checkbox.
 The context menu is displayed whenever you right-click over the checkbox.
 Use the Matlab uicontextmenu function to create the context menu.
ContextMenu Handle, default value: []
 The handle of the context menu associated with the checkbox.
 The context menu is displayed whenever you right-click over the checkbox.
 Use the Matlab uicontextmenu function to create the context menu.
Enable {on} | inactive | off
 Disable or enable the component.
 This property controls how components respond to user interaction.
 Possible values for this property:
  on ? The component is operational (the default).
  inactive ? The component is not operational, but looks the same as when Enable is on.
  off ? The component is not operational and is grayed out.
Extent Width and height are the dimensions of the rectangle. All measurements are in units specified by the Units property.
 Position rectangle (read only).
 A four-element vector that defines the size and position of the component.
 It has the form: [xpos,ypos,width,height]
 The first two elements are always zero are the component's position on the x- and y-axis. w
FontAngle {normal} | italic
 Setting this property to italic selects a slanted version of the component's font, when it is available on your system.
FontName String, default is system dependent.
 The name of the font in which to display the text in the components.
 To display and print properly, this must be a font that your system supports.
 Use listfonts to list all available system fontnames.
FontSize Integer, default value is system dependent.
 A number specifying the size in pixels of the component's font.
FontUnits {points} | normalized | inches | centimeters | pixels
 This property determines the units used by the FontSize property.
 Normalized units interpret FontSize as a fraction of the height of the uicontrol. When you resize the uicontrol, MATLAB modifies the screen FontSize accordingly.
 pixels, inches, centimeters, and points are absolute units (1 point = 1/72 inch).
FontWeight {normal} | bold
 Setting this property to bold selects a bold version of the component's font, when it is available on your system.
ForegroundColor RGB triple, default value is system dependent
 The foreground (text) color of the checkbox.
HorizontalAlignment {leading} | trailing | left | right | center
 The alignment of the checkbox' contents along the X axis.
Icon matrix, default value is []
 M x N x 3 truecolor matrix of an M x N pixels image to be displayed on the checkbox.
 Each value must be an RGB value between 0.0 and 1.0.
 CData(:,:,1) defines the red components of the pixels
 CData(:,:,2) defines the green components of the pixels
 CData(:,:,3) defines the blue components of the pixels
 Transparant pixels are marked with NaN's
Interruptible off | {on}
 Callback routine interruption.
 Controls whether MATLAB can interrupt an object's callback function when subsequent callbacks attempt to interrupt it.
JavaHandle Java object
 The underlying java object.
 See javacomponent
Margin Vector [top left bottom right]
 Sets space for margin between the checkbox' border and the label.
MatlabHandle Matlab handle
 The handle of the associated Matlab container for this java object.
 See javacomponent
MaximumSize Array, [width height]
 The component's maximum size, measured in pixels.
 The preferred size indicates the best size for the component.
 The component should be no larger than its maximum size and no smaller than its minimum size.
 NOTE: Matlab may overrule this setting if the component is not in
 a Panel, ScrollPane, Toolbar, SplitPane or TabbedPane.
MinimumSize Array, [width height]
 The component's minimum size, measured in pixels.
 The preferred size indicates the best size for the component.
 The component should be no larger than its maximum size and no smaller than its minimum size.
 NOTE: Matlab may overrule this setting if the component is not in
 a Panel, ScrollPane, Toolbar, SplitPane or TabbedPane.rtain layout managers.
Mnemonic Character, default value: ''
 The mnemonic is the key which when combined with the look and feel's mouseless modifier (usually Alt) will activate this checkbox.
 Mnemonics are case-insensitive. If the character defined by the mnemonic is found within the checkbox' label string, the first occurrence of it will be underlined to indicate the mnemonic to the user.
MouseClickedCallback String, cell array or function handle, default value: []
 Specifies the function that should be executed when the mouse is clicked on the component
MouseEnteredCallback String, cell array or function handle, default value: []
 Specifies the callback function that should be executed when the mouse enters the component.
MouseExitedCallback String, cell array or function handle, default value: []
 Specifies the callback function that should be executed when the mouse exits the component.
NextFocusableComponent Jacontrol, default value: []
 Specifies the next component to get the focus after this one.
 for example, when the tab key or shift-tab key is used.
Parent The component's parent.
Position Array, [width height]
 Size and location of the component.
 The rectangle defined by this property specifies the size and location of the component within the parent.
 Specify Position as [left bottom width height]
 left and bottom are the distance from the lower-left corner of the parent object to the lower-left corner of the component.
 width and height are the dimensions of the component. All measurements are in units specified by the Units property.
PreferredSize Array, [width height]
 The component's preferred size, measured in pixels.
 The preferred size indicates the best size for the component.
 The component should be no larger than its maximum size and no smaller than its minimum size.
 NOTE: Matlab may overrule this setting if the component is not in
 a Panel, ScrollPane, Toolbar, SplitPane or TabbedPane.
SelectedIcon matrix, default value is []
 M x N x 3 truecolor matrix of an M x N pixels image to be displayed on the checkbox if it is selected.
 Each value must be an RGB value between 0.0 and 1.0.
 CData(:,:,1) defines the red components of the pixels
 CData(:,:,2) defines the green components of the pixels
 CData(:,:,3) defines the blue components of the pixels
 Transparant pixels are marked with NaN's
String String, default value: ''
 The text displayed with the checkbox.
 If the component is too small to accommodate the specified text  the string is truncated with an ellipsis.
 HTML can be used to format the text.
Style CheckBox (Read only)
Tag String, default value: ''
 User specified object identifier.
 Use this tag i.c.w. gcjh('tag',parent) to find a modelit.ui.Jacontrol
TooltipString String, default value: ''
 The TooltipString property specifies the text of the tooltip associated with the checkbox.
 When the user moves the mouse pointer over the button and leaves it there, the tooltip is displayed.
 HTML can be used to format the text.
Type Read only property fixed to 'Jacontrol'
 String with the object type.
Units {pixels} | normalized | inches | centimeters | points | characters
 Used to interpret the extent and position properties.
 All units are measured from the lower-left corner of the parent object.
 Normalized units map the lower-left corner of the parent object to (0,0) and the upper-right corner to (1.0,1.0).
 pixels, inches, centimeters, and points are absolute units (1 point = 1/72 inch).
 Character units are characters using the default system font; the width of one character is the width of the letter x, the height of one character is the distance between the baselines of two lines of text.
 If you change the value of Units, it is good practice to return it to its default value after completing your computation so as not to affect other functions that assume Units is set to the default value.
Userdata Array, default value: []
 User specified data for this modelit.ui.Jacontrol object
Value Boolean, default value: False
 False if the checkbox is not selected, True otherwise.
VerticalAlignment {center} | bottom | top
 The alignment of the checkbox' contents along the Y axis.
Visible Off | {On}
 Component visibility.
 By default, all jacontrols are visible. When set to off, the jacontrol is not visible, but still exists and you can query and set its properties.

Public Method: cleanup

DESCRIPTION:

Reset object fields to empty values, called by the destructor.

CALL:

cleanup(obj)

INPUT:

obj any
modelit.ui.Jacontrol

OUTPUT:

   No output

Public Method: CheckBox

DESCRIPTION:

modelit.ui.CheckBox constructor

CALL:

obj = modelit.ui.CheckBox(parent, varargin)

INPUT:

parent any
handle of the CheckBox' parent e.g. gcf or modelit.ui.Panel
varargin any
parameter-value pairs, see CheckBox properties for a
description of the parameters and their values
Documentation for modelit.ui.CheckBox/CheckBox
   doc modelit.ui.CheckBox

Public Method: delete

Inherited from modelit.ui.Jacontrol

DESCRIPTION:

modelit.ui.Jacontrol destructor.

CALL:

delete(obj)

INPUT:

obj any
modelit.ui.Jacontrol

OUTPUT:

   No output

Help for modelit.ui.CheckBox/delete is inherited from superclass MODELIT.UI.JACONTROL

Public Method: isappdata

Inherited from modelit.ui.Jacontrol

DESCRIPTION:

True if application defined data exists.

CALL:

value = isappdata(obj, name)

INPUT:

obj any
a modelit.ui.Jacontrol object
name any
string with the name of the application data

OUTPUT:

value any
    True if the application defined data exists
Help for modelit.ui.CheckBox/isappdata is inherited from superclass MODELIT.UI.JACONTROL

Public Method: getappdata

Inherited from modelit.ui.Jacontrol

DESCRIPTION:

Get application defined data.

CALL:

value = getappdata(obj, name)

INPUT:

obj any
a modelit.ui.Jacontrol object
name any
string with the name of the application data

OUTPUT:

value any
    The application defined data
Help for modelit.ui.CheckBox/getappdata is inherited from superclass MODELIT.UI.JACONTROL

Public Method: setappdata

Inherited from modelit.ui.Jacontrol

DESCRIPTION:

Set application defined data.

CALL:

setappdata(obj, name, value)

INPUT:

obj any
a modelit.ui.Jacontrol object
name any
string with the name of the application data
value any
value to be stored. May be anything

OUTPUT:

   No output. The application-defined data,
   which is created if it does not already exist, is
   assigned a name and a value.

Help for modelit.ui.CheckBox/setappdata is inherited from superclass MODELIT.UI.JACONTROL

Public Method: ishandle

Inherited from modelit.ui.Jacontrol

DESCRIPTION:

Returns true if this is a valid graphics object

CALL:

value = ishandle(obj)

INPUT:

obj any
a modelit.ui.Jacontrol object

OUTPUT:

value any
    boolean: true if this is a valid graphics object
    What does "valid" mean in this context??
    Matlab HG object/container that holds still exist?
Help for modelit.ui.CheckBox/ishandle is inherited from superclass MODELIT.UI.JACONTROL

Public Method: java

Inherited from modelit.ui.Jacontrol

DESCRIPTION:

Returns the underlying Java object

CALL:

jobj = java(obj)

INPUT:

obj any
a modelit.ui.Jacontrol object

OUTPUT:

jobj any
    java object
Help for modelit.ui.CheckBox/java is inherited from superclass MODELIT.UI.JACONTROL

Public Method: handle

Inherited from modelit.ui.Jacontrol

DESCRIPTION:

Returns the handle of the component's Matlab container

CALL:

h = handle(obj)

INPUT:

obj any
a modelit.ui.Jacontrol object

OUTPUT:

h any
    handle of the component's Matlab container
Help for modelit.ui.CheckBox/handle is inherited from superclass MODELIT.UI.JACONTROL

Public Method: ancestor

Inherited from modelit.ui.Jacontrol

DESCRIPTION:

Returns the handle of the closest ancestor of obj that matches one of the types in type,

CALL:

p = ancestor(obj, type)

INPUT:

obj any
modelit.ui.Jacontrol
type any
String or cell array of strings (types)

OUTPUT:

p any
      handle of the closest ancestor of the obj that matches one of the types in type
Help for modelit.ui.CheckBox/ancestor is inherited from superclass MODELIT.UI.JACONTROL

Protected Static Sealed Method: getDefaultScalarElement

Inherited from modelit.ui.AbstractJacontrol

DESCRIPTION:

Create a default object for heterogeneous arrays. Help for modelit.ui.CheckBox.getDefaultScalarElement is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL

Public Sealed Method: ne

Inherited from modelit.ui.AbstractJacontrol

DESCRIPTION:

Not equal relation for handles. Help for modelit.ui.CheckBox/ne is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL

Public Sealed Method: eq

Inherited from modelit.ui.AbstractJacontrol

DESCRIPTION:

Equal relation for handles. Help for modelit.ui.CheckBox/eq is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL

Public Sealed Method: findobj

Inherited from modelit.ui.AbstractJacontrol

DESCRIPTION:

Returns the objects whose property values match those passed as param-value pairs to the findobj command. Help for modelit.ui.CheckBox/findobj is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL

Public Sealed Method: set

Inherited from modelit.ui.AbstractJacontrol

DESCRIPTION:

Set object properties Help for modelit.ui.CheckBox/set is inherited from superclass MODELIT.UI.ABSTRACTJACONTROL